<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class OAuthSignatureMethod</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class OAuthSignatureMethod</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|													<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A class for implementing a Signature Method</p>
<p class="description"><p>See section 9 (&quot;Signing Requests&quot;) in the spec</p></p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_OAuth.php.html">/OAuth.php</a> (line <span class="field">59</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../default/OAuthSignatureMethod_HMAC_SHA1.html">OAuthSignatureMethod_HMAC_SHA1</a></td>
					<td>
											The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104]  where the Signature Base String is the text and the key is the concatenated values (each first  encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&amp;'  character (ASCII code 38) even if empty.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../default/OAuthSignatureMethod_PLAINTEXT.html">OAuthSignatureMethod_PLAINTEXT</a></td>
					<td>
											The PLAINTEXT method does not provide any security protection and SHOULD only be used  over a secure channel such as HTTPS. It does not use the Signature Base String.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../default/OAuthSignatureMethod_RSA_SHA1.html">OAuthSignatureMethod_RSA_SHA1</a></td>
					<td>
											The RSA-SHA1 signature method uses the RSASSA-PKCS1-v1_5 signature algorithm as defined in
										</td>
				</tr>
							</table>
		</div>
	</div>



	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																												
												<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#build_signature" title="details" class="method-name">build_signature</a>
											(<span class="var-type"><a href="../default/OAuthRequest.html">OAuthRequest</a></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../default/OAuthConsumer.html">OAuthConsumer</a></span>&nbsp;<span class="var-name">$consumer</span>, <span class="var-type"><a href="../default/OAuthToken.html">OAuthToken</a></span>&nbsp;<span class="var-name">$token</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#check_signature" title="details" class="method-name">check_signature</a>
											(<span class="var-type"><a href="../default/OAuthRequest.html">OAuthRequest</a></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../default/OAuthConsumer.html">OAuthConsumer</a></span>&nbsp;<span class="var-name">$consumer</span>, <span class="var-type"><a href="../default/OAuthToken.html">OAuthToken</a></span>&nbsp;<span class="var-name">$token</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$signature</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_name" title="details" class="method-name">get_name</a>
										()
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodbuild_signature" id="build_signature"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">build_signature</span> (line <span class="line-number">76</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Build up the signature  NOTE: The output of this function MUST NOT be urlencoded.</p>
<p class="description"><p>the encoding is handled in OAuthRequest when the final  request is serialized</p></p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			build_signature
		</span>
					(<span class="var-type"><a href="../default/OAuthRequest.html">OAuthRequest</a></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../default/OAuthConsumer.html">OAuthConsumer</a></span>&nbsp;<span class="var-name">$consumer</span>, <span class="var-type"><a href="../default/OAuthToken.html">OAuthToken</a></span>&nbsp;<span class="var-name">$token</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../default/OAuthRequest.html">OAuthRequest</a></span>
				<span class="var-name">$request</span>			</li>
					<li>
				<span class="var-type"><a href="../default/OAuthConsumer.html">OAuthConsumer</a></span>
				<span class="var-name">$consumer</span>			</li>
					<li>
				<span class="var-type"><a href="../default/OAuthToken.html">OAuthToken</a></span>
				<span class="var-name">$token</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../default/OAuthSignatureMethod_HMAC_SHA1.html#methodbuild_signature">OAuthSignatureMethod_HMAC_SHA1::build_signature()</a>
							</li>
					<li>
				<a href="../default/OAuthSignatureMethod_PLAINTEXT.html#methodbuild_signature">OAuthSignatureMethod_PLAINTEXT::build_signature()</a>
								: oauth_signature is set to the concatenated encoded values of the Consumer Secret and  Token Secret, separated by a '&amp;' character (ASCII code 38), even if either secret is  empty. The result MUST be encoded again.
							</li>
					<li>
				<a href="../default/OAuthSignatureMethod_RSA_SHA1.html#methodbuild_signature">OAuthSignatureMethod_RSA_SHA1::build_signature()</a>
							</li>
				</ul>
	</div>
<a name="methodcheck_signature" id="check_signature"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">check_signature</span> (line <span class="line-number">86</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Verifies that a given signature is correct</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			check_signature
		</span>
					(<span class="var-type"><a href="../default/OAuthRequest.html">OAuthRequest</a></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../default/OAuthConsumer.html">OAuthConsumer</a></span>&nbsp;<span class="var-name">$consumer</span>, <span class="var-type"><a href="../default/OAuthToken.html">OAuthToken</a></span>&nbsp;<span class="var-name">$token</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$signature</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../default/OAuthRequest.html">OAuthRequest</a></span>
				<span class="var-name">$request</span>			</li>
					<li>
				<span class="var-type"><a href="../default/OAuthConsumer.html">OAuthConsumer</a></span>
				<span class="var-name">$consumer</span>			</li>
					<li>
				<span class="var-type"><a href="../default/OAuthToken.html">OAuthToken</a></span>
				<span class="var-name">$token</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$signature</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../default/OAuthSignatureMethod_RSA_SHA1.html#methodcheck_signature">OAuthSignatureMethod_RSA_SHA1::check_signature()</a>
							</li>
				</ul>
	</div>
<a name="methodget_name" id="get_name"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_name</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Needs to return the name of the Signature Method (ie HMAC-SHA1)</p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_name
		</span>
				()
			</div>
	
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../default/OAuthSignatureMethod_HMAC_SHA1.html#methodget_name">OAuthSignatureMethod_HMAC_SHA1::get_name()</a>
							</li>
					<li>
				<a href="../default/OAuthSignatureMethod_PLAINTEXT.html#methodget_name">OAuthSignatureMethod_PLAINTEXT::get_name()</a>
							</li>
					<li>
				<a href="../default/OAuthSignatureMethod_RSA_SHA1.html#methodget_name">OAuthSignatureMethod_RSA_SHA1::get_name()</a>
							</li>
				</ul>
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>